/*
 * Funambol is a mobile platform developed by Funambol, Inc. 
 * Copyright (C) 2008 Funambol, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission 
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License 
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 * 
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably 
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */
 
#ifndef INCL_PIM_CHANGES_TRACKER
#define INCL_PIM_CHANGES_TRACKER

#include "base/util/StringBuffer.h"
#include "base/util/Enumeration.h"

using namespace Funambol;

/**
* It is used to fill the array list with the modificated items ids and 
* with the all items ids (for the slow sync)
*/
class ChangesTracker {

protected:
    
    /**
    * Enumeration of the new keys
    */
    Enumeration*   newKeys;
    /**
    * Enumeration of the updated keys
    */
    Enumeration*   updatedKeys;
    /**
    * Enumeration of the deleted keys
    */
    Enumeration*   deletedKeys;       

    /**
    * Enumeration of the deleted keys
    */
    Enumeration*   allKeys;       
       
public:
    
    /**
    * Contructor. 
    */
    ChangesTracker(){};

    /**
    * Destructor. 
    */
    virtual ~ChangesTracker(){};
    
    
    /**
    * It fills the enumeration with the new, modified or deleted keys.
    */
    virtual void getModifications(unsigned long lastsynctime) = 0;
    
    /**
    * It fills the enumeration with all the keys.
    */
    virtual void getAll() = 0;

    /**
     * Get the next value of the new PIMItem in the local db
     */ 
    virtual StringBuffer* getNextNewId() {
        StringBuffer* val = (StringBuffer*)(newKeys->getNextElement());
        if(val){
            return val;
        }
        return NULL;
    }
    /**
     * Get the next value of the updated PIMItem in the local db
     */ 
    virtual StringBuffer* getNextUpdateId() {
        StringBuffer* val = (StringBuffer*)(updatedKeys->getNextElement());
        if(val){
            return val;
        }
        return NULL;
    }
    /**
     * Get the next value of the deleted PIMItem in the local db
     */ 
    virtual StringBuffer* getNextDeleteId() {
        StringBuffer* val = (StringBuffer*)(deletedKeys->getNextElement());
        if(val){
            return val;
        }
        return NULL;
    }
    
    /**
     * Get the next value of the list of "all" PIMItem in the local db
     */ 
    virtual StringBuffer* getNextId() {
        StringBuffer* val = (StringBuffer*)(allKeys->getNextElement());
        if(val){
            return val;
        }
        return NULL;
    }
   
   
};
#endif
